Use the HttpGetRequest Activity
Use caution when building or editing a workflow. For further advice or to arrange training, contact your professional services consultant.
The HttpGetRequest activity can be used to make a GET REST call to an authenticated Application Programming Interface (API).
The HttpGetRequest activity is located in the REST section of the Tribal Toolbox.
The minimum requirement for the HttpGetRequest activity is URL.
This activity contains the following relevant properties:
| Section | This field | Holds this information... |
|---|---|---|
| Behaviour | FailIfNotSuccessful |
Whether the workflow must terminate if a successful response is received (for example: a 400 Bad Request error) - input true or false. The FailIfNotSuccessful property is set to false by default. |
| Inputs | Accept |
The accept header string value (for example: application/xml). The Accept property is set to application/json by default. |
| Authorization | The authorisation header. | |
| QueryStringParameters | The optional dictionary parameters (key/value string pairs) that will be automatically appended to the URL following the '?', separated by '&', with '=' inserted between the key and value. | |
| RequestApiHeaders | The Hypertext Transfer Protocol (HTTP) headers (for example: Authorisation, Accept and Content-type). | |
| URL | The REST Service Uniform Resource Locator (URL). | |
| Misc | DisplayName |
The title of the activity. The DisplayName property is set to HTTPGetRequest by default. |
| Outputs | ResponseContent | The output response, if any (for example: a string typically containing JSON or XML). |
| StatusCode | The HTTP response code that indicates the status of the call to the web service (for example: 200, 401, 404, 503). |
Clicking the ellipsis button adjacent to the relevant field opens the Expression Editor, where you can enter the relevant code in the Visual Basic (VB) format.
Refer to Build a Workflow for a video describing how this activity can be used in a workflow.